home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 2002 November / SGI Freeware 2002 November - Disc 2.iso / dist / fw_hylafax.idb / usr / freeware / catman / u_man / cat1 / faxalter.Z / faxalter
Text File  |  2002-07-08  |  7KB  |  140 lines
  1. FAXALTER(1)                          FAXALTER(1)
  2.  
  3.  
  4.  
  5. NNAAMMEE
  6.        faxalter     -  alter  parameters of a _H_y_l_a_F_A_X job queued for
  7.        transmission
  8.  
  9. SSYYNNOOPPSSIISS
  10.        ffaaxxaalltteerr    [ _o_p_t_i_o_n_s ] _i_d...
  11.  
  12. DDEESSCCRRIIPPTTIIOONN
  13.        _f_a_x_a_l_t_e_r    changes    the state of one  or  more  _H_y_l_a_F_A_X  jobs
  14.        that are    queued for transmission.  Numerous parameters can
  15.        be altered; see the options below.
  16.  
  17.        An _i_d is    a number that identifies a _j_o_b that has    been sub
  18.        mitted to _H_y_l_a_F_A_X; these    numbers    are printed by _s_e_n_d_f_a_x(1)
  19.        when jobs are queued for    transmission and can also be dis
  20.        played  with _f_a_x_s_t_a_t(1).     Unprivileged users can    alter the
  21.        parameters of jobs that they own; clients with administra
  22.        tive  privileges     on  a server can manipulate any job.  By
  23.        default,    _f_a_x_a_l_t_e_r contacts the  facsimile  server  on  the
  24.        host  specified in the FFAAXXSSEERRVVEERR    environment variable; but
  25.        consult the --hh option for more information.
  26.  
  27. OOPPTTIIOONNSS
  28.        --aa _t_i_m_e     Specify a new time to send a  job.   The  syntax
  29.          for  specifying  a  time  is the same as used by
  30.          _s_e_n_d_f_a_x(1) (and _a_t(1)).
  31.  
  32.        --hh _h_o_s_t     Force the server to be    contacted on  a     specific
  33.          _h_o_s_t.    The _h_o_s_t may be    either a symbolic name or
  34.          a network address.  If    no --hh option is    supplied,
  35.          _f_a_x_a_l_t_e_r uses the FAXSERVER environment variable
  36.          to identify the _H_y_l_a_F_A_X server    to  contact.   If
  37.          this  variable     is not    set, then _f_a_x_a_l_t_e_r checks
  38.          for a setting in the configuration files  (first
  39.          in the    per-user file and then in the system-wide
  40.          file).     If all    of the above fails, then _f_a_x_a_l_t_e_r
  41.          attempts  to  contact    a  server  on the machine
  42.          where it is run.
  43.  
  44.        --kk _t_i_m_e     Specify a new time to kill a job; the syntax  is
  45.          the same as used for the --aa option.
  46.  
  47.        --mm _m_o_d_e_m     Assign/reassign the jobs to the specified _m_o_d_e_m.
  48.          Specifying ``any'' for    _m_o_d_e_m causes the jobs  to
  49.          be scheduled for any available    modem.
  50.  
  51.        --pp     The  jobs should be _p_u_s_h_e_d; that is, they should
  52.          be sent immediately (this is equivalent to  ``-a
  53.          now''.)
  54.  
  55.        --PP _p_r_i     Set  the  scheduling  priority    for the    specified
  56.          jobs.    The priority is    an integer value  in  the
  57.          range 0-255; lower values give    a job higher pri
  58.          ority.     The default scheduling     priority  for    a
  59.          job is    127 and    priorities are recalculated after
  60.          each attempt to process a job.
  61.  
  62.        --tt _t_r_i_e_s     Set the  maximum  number  of  times  the  server
  63.          should    call the remote    fax machine.
  64.  
  65.        --nn _s_c_h_e_m_e Select     a  notification  scheme  to  use for the
  66.          specified jobs.  Possible schemes are:     ``_n_o_n_e''
  67.          for no    notification (default),    ``_w_h_e_n _d_o_n_e'' for
  68.          notification when the job is  completed,  ``_w_h_e_n
  69.          _r_e_q_u_e_u_e_d''  for  notification    when  the  job is
  70.          requeued after    a  failed  transmission     attempt.
  71.          The  --QQ,  --DD,    and  --RR    options    are shorthand for
  72.          these notification schemes,  respectively.   One
  73.          can  also  leave  off ``_w_h_e_n''    when using the --nn
  74.          option; e.g., ``_d_o_n_e''    instead    of ``_w_h_e_n _d_o_n_e''.
  75.  
  76.        --vv     Trace    the  protocol  exchanges between _f_a_x_a_l_t_e_r
  77.          and the remote    _h_f_a_x_d process.    Tracing     informa
  78.          tion is written to the    standard output.
  79.  
  80. CCOONNFFIIGGUURRAATTIIOONN PPAARRAAMMEETTEERRSS
  81.        _f_a_x_a_l_t_e_r     reads    configuration  information  from the file
  82.        $${{LLIIBBDDAATTAA}}//hhyyllaa..ccoonnff and    then  from  the     file  ~~//..hhyyllaarrcc.
  83.        Configuration  files  follow  the conventions described in
  84.        _h_y_l_a_f_a_x_-_c_l_i_e_n_t(1).  The following configuration parameters
  85.        are recognized:
  86.        TTaagg        TTyyppee       DDeeffaauulltt    DDeessccrriippttiioonn
  87.        Host        string       localhost    host to    contact    for service
  88.        Port        integer       4559        port to    use in contacting server
  89.        Protocol        string       tcp        protocol to use    in contacting server
  90.        Verbose        boolean       No        whether    or not to enable protocol tracing
  91.  
  92.        The configuration parameters are    explained below:
  93.  
  94.        HHoosstt     The host to contact for service.  (Equivalent to
  95.          the --hh    option.)
  96.  
  97.        PPoorrtt     The  network  port  to     contact   for     service.
  98.          (Eqvuialent to    the --hh option.)
  99.  
  100.        PPrroottooccooll     The  name  of    the communication protocol to use
  101.          when contacting a server.   (Equivalent  to  the
  102.          FFAAXXSSEERRVVIICCEE environment    variable.)
  103.  
  104.        VVeerrbboossee     Control protocol tracing.  (Equivalent    to the --vv
  105.          option.)
  106.  
  107. BBUUGGSS
  108.        Setting a job's killtime    without    also setting the time  to
  109.        send  may  cause     the  wrong  value for the killtime to be
  110.        sent.  This is because the killtime is calculated  as  the
  111.        difference  in time between the killtime    and time to send:
  112.        and if the time to send is not  specified,  then     _f_a_x_a_l_t_e_r
  113.        uses  the  current time instead of querying the server for
  114.        the job's time to send.
  115.  
  116.        _f_a_x_a_l_t_e_r    suspends a job before  attempting  to  alter  its
  117.        state.    If a job is active when    a suspend request is made
  118.        there may be a delay while waiting for the job to enter    a
  119.        consistent  state  where    it can be suspended.  If _f_a_x_a_l_t_e_r
  120.        is interrupted during this time then jobs may be    left sus
  121.        pended.
  122.  
  123.        _f_a_x_a_l_t_e_r     only  understands  how     to alter a subset of the
  124.        available job parameters; there are many    more  client-con
  125.        trollable parameters that can only be modified by communi
  126.        cating directly with the    server using the underlying  pro
  127.        tocol.
  128.  
  129.        The continued use of the    _a_t(1)-style notation for specify
  130.        ing times is questionable (it was done for backwards  com
  131.        patibility).
  132.  
  133. SSEEEE AALLSSOO
  134.        _h_y_l_a_f_a_x_-_c_l_i_e_n_t(1),   _s_e_n_d_f_a_x(1),      _f_a_x_r_m(1),   _f_a_x_s_t_a_t(1),
  135.        _h_f_a_x_d(${MANNUM1_8})
  136.  
  137.  
  138.  
  139.               July 11, 1996              FAXALTER(1)
  140.